Skip to content

[test] add CI workflow for VCS installation#22701

Closed
XuehaiPan wants to merge 4 commits into
huggingface:mainfrom
XuehaiPan:check-vcs-installation
Closed

[test] add CI workflow for VCS installation#22701
XuehaiPan wants to merge 4 commits into
huggingface:mainfrom
XuehaiPan:check-vcs-installation

Conversation

@XuehaiPan

@XuehaiPan XuehaiPan commented Apr 11, 2023 •
edited
Loading

Copy link
Copy Markdown
Contributor

What does this PR do?

Add a CI test for checking VCS installation (via URL or git repo). This workflow prevents potential breakage for install from source installation method.

Ref:

Before submitting

  • This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
  • Did you read the contributor guideline,
    Pull Request section?
  • Was this discussed/approved via a Github issue or the forum? Please add a link
    to it if that's the case.
  • Did you make sure to update the documentation with your changes? Here are the
    documentation guidelines, and
    here are tips on formatting docstrings.
  • Did you write any new necessary tests?

Who can review?

Anyone in the community is free to review the PR once the tests have passed. Feel free to tag
members/contributors who may be interested in your PR.

XuehaiPan
XuehaiPan commented Apr 11, 2023
View reviewed changes
Comment thread .github/workflows/check-vcs-installation.yml Outdated
@XuehaiPan XuehaiPan marked this pull request as draft April 11, 2023 03:36
@XuehaiPan XuehaiPan force-pushed the check-vcs-installation branch 3 times, most recently from ebd03ad to f0daff5 Compare April 11, 2023 03:46
@XuehaiPan XuehaiPan marked this pull request as ready for review April 11, 2023 03:48
@XuehaiPan XuehaiPan marked this pull request as draft April 11, 2023 03:52
@XuehaiPan XuehaiPan force-pushed the check-vcs-installation branch 7 times, most recently from 5ea0d5c to 2ba9a42 Compare April 11, 2023 04:08
@XuehaiPan XuehaiPan marked this pull request as ready for review April 11, 2023 04:09
@XuehaiPan XuehaiPan force-pushed the check-vcs-installation branch from 2ba9a42 to 14a9ea6 Compare April 11, 2023 04:13
@HuggingFaceDocBuilderDev

HuggingFaceDocBuilderDev commented Apr 11, 2023

Copy link
Copy Markdown

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint.

@XuehaiPan XuehaiPan force-pushed the check-vcs-installation branch from 9a17987 to 4bf1a88 Compare April 11, 2023 04:50
@XuehaiPan XuehaiPan force-pushed the check-vcs-installation branch from 4bf1a88 to be23fce Compare April 11, 2023 04:53
XuehaiPan
XuehaiPan commented Apr 11, 2023
View reviewed changes
Comment thread .github/workflows/check-vcs-installation.yml

jobs:
check-vcs-installation:
runs-on: ubuntu-20.04 # the oldest Ubuntu LTS version

@XuehaiPan XuehaiPan Apr 11, 2023 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe also add test for macOS and Windows. But I think it would be unnecessary. The wheel for transformers is platform-independent (the dependencies are platform-dependent).

@sgugger

sgugger commented Apr 11, 2023

Copy link
Copy Markdown
Collaborator

Or we can just leave the setup as is and there won't be any need for this new check :-)

@XuehaiPan

XuehaiPan commented Apr 11, 2023

Copy link
Copy Markdown
Contributor Author

Or we can just leave the setup as is and there won't be any need for this new check :-)

The CI workflows in this PR can also benefit to check the viability of transformers' dependencies.

I think the ultimate solution is to ask the user to upgrade their pip first in the documentation:

pip install --upgrade pip setuptools  # upgrade to support PEP 660
pip install git+https://github.com/huggingface/transformers

@github-actions

github-actions Bot commented May 11, 2023

Copy link
Copy Markdown
Contributor

This issue has been automatically marked as stale because it has not had recent activity. If you think this still needs to be addressed please comment on this thread.

Please note that issues that do not follow the contributing guidelines are likely to be ignored.

@github-actions github-actions Bot closed this May 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@XuehaiPan @HuggingFaceDocBuilderDev @sgugger